﻿/**
 * @file std_stack.c
 * Copyright (c) 2019 Gaaagaa. All rights reserved.
 * 
 * @author  : Gaaagaa
 * @date    : 2019-09-09
 * @version : 1.0.0.0
 * @brief   : 使用 C API 的接口形式实现 栈 容器。
 */

/**
 * The MIT License (MIT)
 * Copyright (c) Gaaagaa. All rights reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#include "std_stack.h"
#include "std_debug.h"
#include "std_stack.inl"

////////////////////////////////////////////////////////////////////////////////

#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-function"
#endif // __GNUC__

////////////////////////////////////////////////////////////////////////////////

//====================================================================

// 
// xstd_stack_t 的外部相关操作接口
// 

/**********************************************************/
/**
 * @brief 计算出适合的 xstk_chunk_t 对象缓存大小：2^N 。
 */
static inline xstk_size_t stack_chunk_size(xstk_this_t xstk_this)
{
#if 1
    if (XSTK_ESIZE(xstk_this) <= (1 << 4))
    {
        return ((xstk_size_t)(1) << 
            ((xstk_size_t)(5) - std_ceil2pn(XSTK_ESIZE(xstk_this))));
    }
#else
    if (XSTK_ESIZE(xstk_this) <= 1)
        return 32;
    else if (XSTK_ESIZE(xstk_this) <= 2)
        return 16;
    else if (XSTK_ESIZE(xstk_this) <= 4)
        return 8;
    else if (XSTK_ESIZE(xstk_this) <= 8)
        return 4;
    else if (XSTK_ESIZE(xstk_this) <= 16)
        return 2;
#endif
    return 1;
}

/**********************************************************/
/**
 * @brief 申请一个存储对象节点的内存块。
 */
static inline xstk_cptr_t stack_chunk_alloc(xstk_this_t xstk_this)
{
#if XSTK_CHUNK_SEPARATED

    xstk_cptr_t xchk_mptr = 
        (xstk_cptr_t)XSTK_MALLOC(xstk_this, XSTK_SIZEOF_CHUNK(xstk_this));
    XASSERT(XSTK_NULL != xchk_mptr);

    xchk_mptr->xchk_next = XSTK_NULL;

    xchk_mptr->xchk_dptr = 
        (xstd_bptr_t)XSTK_MALLOC(
            xstk_this, xstk_this->xchk_size * XSTK_ESIZE(xstk_this));
    XASSERT(XSTK_NULL != xchk_mptr->xchk_dptr);

#else // !XSTK_CHUNK_SEPARATED

    xstk_cptr_t xchk_mptr = 
        (xstk_cptr_t)XSTK_MALLOC(xstk_this, XSTK_SIZEOF_CHUNK(xstk_this));
    XASSERT(XSTK_NULL != xchk_mptr);

#endif // XSTK_CHUNK_SEPARATED

    xchk_mptr->xchk_next = XSTK_NULL;
    return xchk_mptr;
}

/**********************************************************/
/**
 * @brief 释放一个存储对象节点的内存块。
 */
static inline xstk_void_t stack_chunk_dealloc(
                                xstk_this_t xstk_this,
                                xstk_cptr_t xchk_mptr)
{
    if (XSTK_NULL != xchk_mptr)
    {
#if XSTK_CHUNK_SEPARATED

        XSTK_DEALLOC(xstk_this, xchk_mptr->xchk_dptr);
        XSTK_DEALLOC(xstk_this, xchk_mptr);

#else // !XSTK_CHUNK_SEPARATED

        XSTK_DEALLOC(xstk_this, xchk_mptr);

#endif // XSTK_CHUNK_SEPARATED
    }
}

/**********************************************************/
/**
 * @brief 压入新元素节点前，将顶端位置向上移。
 */
static inline xstk_void_t stack_top_upward(xstk_this_t xstk_this)
{
    xstk_cptr_t xchk_mptr = XSTK_NULL;

    if (++xstk_this->xstk_top.xchk_vpos == xstk_this->xchk_size)
    {
        xchk_mptr = stack_chunk_alloc(xstk_this);
        XASSERT(XSTK_NULL != xchk_mptr);

        xchk_mptr->xchk_next = xstk_this->xstk_top.xchk_mptr;

        xstk_this->xstk_top.xchk_mptr = xchk_mptr;
        xstk_this->xstk_top.xchk_vpos = 0;
    }
}

/**********************************************************/
/**
 * @brief 弹出顶端元素后，将顶端位置向下移。
 */
static inline xstk_void_t stack_top_downward(xstk_this_t xstk_this)
{
    xstk_cptr_t xchk_mptr = XSTK_NULL;

    if (xstk_this->xstk_top.xchk_vpos-- == 0)
    {
        xchk_mptr = xstk_this->xstk_top.xchk_mptr;

        xstk_this->xstk_top.xchk_mptr = xchk_mptr->xchk_next;
        xstk_this->xstk_top.xchk_vpos = xstk_this->xchk_size - 1;

        stack_chunk_dealloc(xstk_this, xchk_mptr);        
    }
}

//====================================================================

// 
// xstd_stack_t 的外部相关操作接口
// 

/**********************************************************/
/**
 * @brief 返回内部的 sizeof(xstd_stack_t) 值。
 */
xstk_size_t std_stack_sizeof(void)
{
    return (xstk_size_t)sizeof(xstd_stack_t);
}

/**********************************************************/
/**
 * @brief 创建 xstd_stack_t 对象。
 * @note  应使用 @see std_stack_destroy() 销毁所创建的对象。
 * 
 * @param [in ] xstk_ctxt : 队列 所存储的节点元素上下文描述信息。
 * 
 * @return xstk_this_t : 返回所创建的 xstd_stack_t 对象指针。
 */
xstk_this_t std_stack_create(xstk_ctxt_t xstk_ctxt)
{
    XASSERT(XSTK_NULL != xstk_ctxt);
    XASSERT(0 != xstk_ctxt->xstd_etype);
    XASSERT(0 != xstk_ctxt->xstd_esize);

    xstd_altor_t xstd_altor = XSTD_ALTOR_NCREF(xstk_ctxt->xstd_altor);
    xstk_this_t xstk_this =
        (xstk_this_t)xstd_altor->xfunc_allocate(sizeof(xstd_stack_t));
    XASSERT(XSTK_NULL != xstk_this);

    return std_stack_emplace_create(xstk_this, xstk_ctxt);
}

/**********************************************************/
/**
 * @brief 
 * 销毁 xstd_stack_t 对象，
 * 其由 @see std_stack_create() 接口所创建。
 */
xstk_void_t std_stack_destroy(xstk_this_t xstk_this)
{
    XASSERT(XSTK_NULL != xstk_this);

    xstd_altor_t xstd_altor = XSTK_ALTOR(xstk_this);

    std_stack_emplace_destroy(xstk_this);
    xstd_altor->xfunc_dealloc(xstk_this);
}

/**********************************************************/
/**
 * @brief 在指定的缓存上创建 xstd_stack_t 对象。
 * @note
 * 1. 所使用的缓存，其大小应不小于 @see std_stack_sizeof() 的返回值。
 * 2. 销毁对象时，应使用 @see std_stack_emplace_destroy() 接口。
 * 
 * @param [out] xstk_this : 创建 xstd_stack_t 对象使用的缓存。
 * @param [in ] xstk_ctxt : 队列 所存储的节点元素上下文描述信息。
 * 
 * @return xstk_this_t : 返回所创建的 xstd_stack_t 对象指针。
 */
xstk_this_t std_stack_emplace_create(
                    xstk_this_t xstk_this,
                    xstk_ctxt_t xstk_ctxt)
{
    XASSERT(XSTK_NULL != xstk_this);
    XASSERT(XSTK_NULL != xstk_ctxt);
    XASSERT(0 != xstk_ctxt->xstd_etype);
    XASSERT(0 != xstk_ctxt->xstd_esize);

    //======================================

    XSTK_ECTXT_UPDATE(xstk_this, xstk_ctxt);

    xstk_this->xchk_size = stack_chunk_size(xstk_this);
    xstk_this->xstk_size = 0;

    xstk_this->xstk_top.xchk_mptr = XSTK_NULL;
    xstk_this->xstk_top.xchk_vpos = xstk_this->xchk_size - 1;

    //======================================

    return xstk_this;
}

/**********************************************************/
/**
 * @brief 
 * 销毁 xstd_stack_t 对象，
 * 其由 @see std_stack_emplace_create() 接口所创建。
 */
xstk_void_t std_stack_emplace_destroy(xstk_this_t xstk_this)
{
    XASSERT(XSTK_NULL != xstk_this);

    while (xstk_this->xstk_size > 0)
    {
        std_stack_pop(xstk_this);
    }

    stack_chunk_dealloc(xstk_this, xstk_this->xstk_top.xchk_mptr);
    xstk_this->xstk_top.xchk_mptr = XSTK_NULL;
    xstk_this->xstk_top.xchk_vpos = 0;
}

/**********************************************************/
/**
 * @brief 返回 xstd_stack_t 对象的 上下文信息。
 */
xstk_ctxt_t std_stack_ctxt(xstk_this_t xstk_this)
{
    XASSERT(XSTK_NULL != xstk_this);
    return XSTK_ECTXT(xstk_this);
}

/**********************************************************/
/**
 * @brief 返回 xstd_stack_t 对象的 类型标识。
 */
xstk_size_t std_stack_etype(xstk_this_t xstk_this)
{
    XASSERT(XSTK_NULL != xstk_this);
    return XSTK_ETYPE(xstk_this);
}

/**********************************************************/
/**
 * @brief 返回 xstd_stack_t 对象当前的节点数量。
 */
xstk_size_t std_stack_size(xstk_this_t xstk_this)
{
    XASSERT(XSTK_NULL != xstk_this);
    return xstk_this->xstk_size;
}

/**********************************************************/
/**
 * @brief 判断 xstd_stack_t 对象是否为空。
 */
xstk_bool_t std_stack_empty(xstk_this_t xstk_this)
{
    XASSERT(XSTK_NULL != xstk_this);
    return (0 == xstk_this->xstk_size);
}

/**********************************************************/
/**
 * @brief 返回 xstd_stack_t 对象可容纳最大的节点数量。
 */
xstk_size_t std_stack_maxsize(xstk_this_t xstk_this)
{
    XASSERT(XSTK_NULL != xstk_this);
    return XSTK_MAX_SIZE(xstk_this);
}

/**********************************************************/
/**
 * @brief 返回 xstd_stack_t 对象的顶端节点元素。
 */
xstk_elem_t std_stack_top(xstk_this_t xstk_this)
{
    XASSERT(XSTK_NULL != xstk_this);
    return XSTK_TOP(xstk_this);
}

/**********************************************************/
/**
 * @brief 向 xstd_stack_t 对象压入一个元素。
 * 
 * @param [in,out] xstk_this : xstd_stack_t 对象。
 * @param [in    ] xstk_elem : 所压入的元素值。
 */
xstk_void_t std_stack_push(
                xstk_this_t xstk_this,
                xstk_elem_t xstk_elem)
{
    XASSERT(XSTK_NULL != xstk_this);
    XASSERT(XSTK_NULL != xstk_elem);
    XASSERT(xstk_this->xstk_size < XSTK_MAX_SIZE(xstk_this));

    stack_top_upward(xstk_this);

    XSTK_ALFROM(xstk_this, XSTK_TOP(xstk_this), xstk_elem);
    ++xstk_this->xstk_size;
}

/**********************************************************/
/**
 * @brief 使用右值 move 方式，向 xstd_stack_t 对象压入一个元素。
 * 
 * @param [in,out] xstk_this : xstd_stack_t 对象。
 * @param [in    ] xstk_elem : 所压入的元素值。
 */
xstk_void_t std_stack_mpush(
                xstk_this_t xstk_this,
                xstk_elem_t xstk_elem)
{
    XASSERT(XSTK_NULL != xstk_this);
    XASSERT(XSTK_NULL != xstk_elem);

    stack_top_upward(xstk_this);

    XSTK_ALMOVE(xstk_this, XSTK_TOP(xstk_this), xstk_elem);
    ++xstk_this->xstk_size;
}

/**********************************************************/
/**
 * @brief 对  xstd_stack_t 对象的顶端元素执行弹出（删除）操作。
 */
xstk_void_t std_stack_pop(xstk_this_t xstk_this)
{
    XASSERT(XSTK_NULL != xstk_this);
    XASSERT(xstk_this->xstk_size > 0);

    xstk_cptr_t xchk_mptr = XSTK_NULL;

    //======================================

    XSTK_ALDEST(xstk_this, XSTK_TOP(xstk_this));
    --xstk_this->xstk_size;

    stack_top_downward(xstk_this);

    //======================================
}

////////////////////////////////////////////////////////////////////////////////

#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif // __GNUC__

////////////////////////////////////////////////////////////////////////////////
